'\" te
.\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved
.\" Copyright 1989 AT&T
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
.\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH BIND 3SOCKET "May 11, 2009"
.SH NAME
bind \- bind a name to a socket
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsocket\fR \fB -lnsl \fR [ \fIlibrary\fR ... ]
#include <sys/types.h>
#include <sys/socket.h>



\fBint\fR \fBbind\fR(\fBint\fR \fIs\fR, \fBconst struct sockaddr *\fR\fIname\fR, \fBint\fR \fInamelen\fR);
.fi

.SH DESCRIPTION
.LP
The \fBbind()\fR function assigns a name to an unnamed socket. When a socket is
created with \fBsocket\fR(3SOCKET), it exists in a name space (address family)
but has no name assigned. The \fBbind()\fR function requests that the name
pointed to by \fIname\fR be assigned to the socket.
.SH RETURN VALUES
.LP
Upon successful completion \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
returned and \fBerrno\fR is set to indicate the error.
.SH ERRORS
.LP
The \fBbind()\fR function will fail if:
.sp
.ne 2
.na
\fB\fBEACCES\fR\fR
.ad
.RS 17n
The requested address is protected, and \fB{PRIV_NET_PRIVADDR}\fR is not
asserted in the effective set of the current process.
.RE

.sp
.ne 2
.na
\fB\fBEADDRINUSE\fR\fR
.ad
.RS 17n
The specified address is already in use.
.RE

.sp
.ne 2
.na
\fB\fBEADDRNOTAVAIL\fR\fR
.ad
.RS 17n
The specified address is not available on the local machine.
.RE

.sp
.ne 2
.na
\fB\fBEBADF\fR\fR
.ad
.RS 17n
\fIs\fR is not a valid descriptor.
.RE

.sp
.ne 2
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 17n
\fInamelen\fR is not the size of a valid address for the specified address
family.
.sp
The socket is already bound to an address.
.sp
Socket options are inconsistent with port attributes.
.RE

.sp
.ne 2
.na
\fB\fBENOSR\fR\fR
.ad
.RS 17n
There were insufficient \fBSTREAMS\fR resources for the operation to complete.
.RE

.sp
.ne 2
.na
\fB\fBENOTSOCK\fR\fR
.ad
.RS 17n
\fIs\fR is a descriptor for a file, not a socket.
.RE

.sp
.LP
The following errors are specific to binding names in the UNIX domain:
.sp
.ne 2
.na
\fB\fBEACCES\fR\fR
.ad
.RS 11n
Search permission is denied for a component of the path prefix of the pathname
in \fIname\fR.
.RE

.sp
.ne 2
.na
\fB\fBEIO\fR\fR
.ad
.RS 11n
An I/O error occurred while making the directory entry or allocating the inode.
.RE

.sp
.ne 2
.na
\fB\fBEISDIR\fR\fR
.ad
.RS 11n
A null pathname was specified.
.RE

.sp
.ne 2
.na
\fB\fBELOOP\fR\fR
.ad
.RS 11n
Too many symbolic links were encountered in translating the pathname in
\fIname\fR.
.RE

.sp
.ne 2
.na
\fB\fBENOENT\fR\fR
.ad
.RS 11n
A component of the path prefix of the pathname in \fIname\fR does not exist.
.RE

.sp
.ne 2
.na
\fB\fBENOTDIR\fR\fR
.ad
.RS 11n
A component of the path prefix of the pathname in \fIname\fR is not a
directory.
.RE

.sp
.ne 2
.na
\fB\fBEROFS\fR\fR
.ad
.RS 11n
The inode would reside on a read-only file system.
.RE

.SH ATTRIBUTES
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
MT-Level	Safe
.TE

.SH SEE ALSO
.LP
.BR unlink (2),
.BR socket.h (3HEAD),
.BR sockaddr (3SOCKET),
.BR socket (3SOCKET),
.BR attributes (7),
.BR privileges (7)
.SH NOTES
.LP
Binding a name in the UNIX domain creates a socket in the file system that must
be deleted by the caller when it is no longer needed by using \fBunlink\fR(2).
.sp
.LP
The rules used in name binding vary between communication domains.
